home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / opus / ohslk20b.zip / O-HSLNK.DOC < prev   
Text File  |  1992-07-22  |  12KB  |  246 lines
  1.      ╒╤══╕                                                            ╒══╤╕
  2.      ╘╛  │   ▄▄▄▄ ▄▄▄▄ ▄  ▄ ▄▄▄▄     ▄  ▄ ▄▄▄▄ ▄    ▄▄▄ ▄▄▄ ▄ ▄ ▄▄    │  ╘╛
  3.          │   █  █ █▄▄█ █  █ █▄▄▄ ─── █▄▄█ █▄▄▄ █     █  █ █ █ █▄█▄    │
  4.          ╘═══█▄▄█ █    █▄▄█ ▄▄▄█     █  █ ▄▄▄█ █▄▄▄ ▄█▄ █ █▄█ █  █════╛
  5.                  ▄▄▄ ▄▄▄ ▄ ▄▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄▄ ▄▄▄▄
  6.                   █  █ █ █   █   █▄   █▄▄█ █▄   █▄▄█ █    █▄
  7.                  ▄█▄ █ █▄█   █   █▄▄▄ █ █▄ █    █  █ █▄▄▄ █▄▄▄
  8.  
  9.  
  10.  
  11.                              ╥  ╥      ╓──╖   ╓──╖
  12.                              ║ ╓╜      ╓──╜   ╫  ╫
  13.                              ╙─╜  o    ╙─── o ╙──╜ B
  14.  
  15.                      ┌────────────────────────────────┐
  16.             ─────────┤ Written by Dominic Montalto    ├─────────
  17.                ──────┤ For Opus CBCS Versions 1.7x+   ├──────
  18.                      └────────────────────────────────┘
  19.                                July 19, 1992
  20.                        Documentation by Al Filandro
  21.  
  22.  
  23.  
  24.                        -Opus Hslink Interface 2.0-                    [2]
  25.   -Introduction-
  26.     Since Opus is basically a uni-directional bulletin board system, writing
  27.    interfaces for bi-directional interfaces can be both time consuming and
  28.    frustrating.  Most BBS's (Opus included) will only offer an Upload or
  29.    Download option to the user at once, thus the user will in Opus' eyes, be
  30.    EITHER uploading or downloading.  Some very large and complex interfaces
  31.    for Opus (Such as Eric Labs "BIOPUS" for Bimodem) solved this problem but
  32.    were very tedious to run and even harder to maintain.
  33.     O-hslink takes into account the way Opus "views its customers" in that
  34.    it will instruct someone using both channels of Ohslink to execute Hslink
  35.    again and then allow Opus to ask for a description of the file they just
  36.    sent to the bulletin board thus getting credit for the file(s) they've up-
  37.    loaded. If the user merely downloads and does not invoke Hslink again, the
  38.    program will remain intact until the next time it is used. If the user
  39.    downloads more or uploads more files, they will be added to the "extra-file"
  40.    listing that O-hslink creates.  If the user hangs up for some reason, the
  41.    list will remain intact and the next user who uses Hslink will allow the
  42.    processing of the list created by prior user.  This is essential to allow
  43.    the interface to process these files lest Opus will not know what these
  44.    files are or where they came from.
  45.  
  46.                        -Opus Hslink Interface 2.0-                    [3]
  47.   -Installation-
  48.     Prior versions of Opus-Hslink interfaced required a file named "BBS.CTL"
  49.   to be in your Opus root directory, version 2.0 of this interface conquers
  50.   this problem for those using Hslink on multiline systems or for those
  51.   who simply have different names for their Opus control file.
  52.     With this version, OHSLINK uses a Dos-environment variable to get its
  53.   information of your computers locked DTE rate.  This environment will
  54.   work with Opdsz/Oshlink and Ymodem G interfaces version 2.0.  To set this
  55.   environment, place the following line in your autoexec.bat
  56.  
  57.    SET OPUSINT=<Locked DTE Rate>
  58.  
  59.         Where Locked DTE Rate is the what you have your com port locked at
  60.         If you are not locking your com port, do NOT use this variable!!
  61.   ie:
  62.  
  63.    SET OPUSINT=38400
  64.  
  65.           If this variable is not defined, Opus will revert to the connect
  66.           string to get its baud-rate from, and if this differs from your
  67.  
  68.                        -Opus Hslink Interface 2.0-                    [4]
  69.           locked DTE rate, Hslink itself will exit with errors.
  70.  
  71.    The Archive enclosed in this package can be renamed to any filename
  72.   you desire except "HSLINK.EXE" which is what the interface is looking                     ou want users to choose "O" to initiate HSLINK.  This
  73.   for!  This is useful if you aleady are using an external protocol with
  74.   Opus that begins with the letter 'H'. You can leave it named at "HSLINKS"
  75.   as well.  You must edit your BBS.CTL (or equivilent) file to add the
  76.   interface to Opus' list.
  77.  
  78.   BBS.CTL Example:
  79. %
  80.     EXTERNAL Protocol D:\OPUS\DSZ-ZMOD.EXE
  81.     EXTERNAL Protocol D:\OPUS\GYMODEMG.EXE
  82.         EXTERNAL Protocol D:\OPUS\H-SUPER8.EXE  <--Note "H" is already used.
  83.     EXTERNAL Protocol D:\OPUS\ASCII.EXE
  84.         EXTERNAL Protocol D:\OPUS\IMODEM.EXE
  85.         EXTERNAL Protocol D:\OPUS\O-HSLINK.EXE  <--- Heres The "O"/Hs-Link
  86. %       EXTERNAL Protocol
  87.         Refund  140
  88. %
  89.  
  90.                        -Opus Hslink Interface 2.0-                    [5]
  91.  
  92.  
  93.    Of course, after you are done installing O-HSLINK to your BBS.CTL file,
  94.    you will have to SALT (NACL) it so that it is compiled into your BBS.PRM
  95.    and recognized by Opus.
  96.  
  97.   -Hslink Advantages-
  98.  
  99.      Hslink (The protocol itself) will provide your BBS with one of the best
  100.    protocols ever written for IBM/PC communications.  Hs-link allows a user
  101.    to send AND receive a file or files simultaneously. This saves both you
  102.    and your users time.  Unlike "Bi-Modem" or "SuperZmodem" which allow user
  103.    chats during this time, Hs/Link offers no such Chat capability (like it was
  104.    used often anyways right?), but it does offer a much more stable and secure
  105.    protocol that can be accessed through a single Executable file (HSLINK.EXE)
  106.    unlike Bimodem or SuperZmodem with their six or seven parts and frustrating
  107.    configuration. An asynchronous V32 modem-to-modem connection using Hslink
  108.    will provide combined transfer rates of 3300cps and higher with compressed
  109.    files!
  110.  
  111.  
  112.                        -Opus Hslink Interface 2.0-                    [6]
  113.  
  114.  Hslink is the product of Samuel Smith, a fellow BBS operator and programmer.
  115.  Although the registered version of HS/Link itself will only provide you with
  116.  a status-bar display of the download/upload in progress, I urge you all to
  117.  register the protocol as it is well worth it.
  118.  
  119.  ==How the Interface Works==
  120.  
  121.                 1> Gets the path of the DSZLOG, which is Required.
  122.                    example SET DSZLOG=<DIRECTORY\DSZ.LOG>
  123.                 2> The Task is passed from Opus to the interface
  124.                 3> The old Hslink Log files is deleted.
  125.                 4> The Control File is read into memory.
  126.                 5> The Baud maximum is gotten from Dos environment setting
  127.                 6> Determines to Send or Receive files
  128.                 7> Check to see if HSLKXTRA.FIL exists Extra Files
  129.                    not Recognized by Opus (Task Specific ie HSLKEXT01.FIL)
  130.                       a> If the file exists then each file is copied to
  131.                          the LOG file
  132.                       b> Then the interface exits and Opus gets Descriptions
  133.  
  134.                        -Opus Hslink Interface 2.0-                    [7]
  135.  
  136.                          for the files
  137.                 8> If the HSLKXTRA.FIL does not exist then HSLINK.EXE is
  138.  
  139.  
  140.  
  141.  
  142.                    searched for in your DOS Path
  143.                 9> A SENDLIST (Task Specific) is created for multiple files
  144.                10> HSLINK is now called and the files are sent or received
  145.                11> The DSZLOG is now processed and checked over
  146.                       a> Any files that were partially received will be
  147.                          deleted
  148.                       b> files that all ready exists will be skipped
  149.                       c> If we were sending to the user all files that were
  150.                          received will be put into HSLKXTRA.FIL to be
  151.                           processed later, if files are all ready in
  152.                           HSLKXTRA.FIL then these will be added to them, and
  153.                           a message will be sent to the user on how to get
  154.                           credit for their extra files.
  155.  
  156.                        -Opus Hslink Interface 2.0-                    [8]
  157.  
  158.   -Example Run:-
  159.  
  160.             I Download FILE1.ARJ and Upload FILE2.ARJ and FILE3.ARJ
  161.                  FILE2.ARJ and FILE3.ARJ are not recognized
  162.  
  163.                       This Message gets sent to me......
  164.  
  165.            °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  166.            ▌   If you want to get Credit For your extra files sent, ▌
  167.            ▌ Just choose UPLOAD with a bogus filename using HSLINK  ▌
  168.            ▌ and the Interface will Trick the BBS into thinking     ▌
  169.            ▌ That you just Uploaded The Files now, then ask you     ▌
  170.            ▌ for Descriptions of them.                              ▌
  171.            ▌  NOTICE: Do Not invoke Your HSLINK.                    ▌
  172.            ▌   Example:U,choose HSLINK,BOGUS.TXT                    ▌
  173.            °°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
  174.  
  175.                      Make the above CLEAR to your users 
  176.  
  177.  
  178.                        -Opus Hslink Interface 2.0-                    [9]
  179.  
  180. [example continued]
  181.  
  182. File area   02 .. NewUploads       New Uploads on Cygnus X-I
  183. ------------------------------------------------------------
  184. FILES: U;H anyname.ext <ENTER>
  185.  
  186.         The Interface now runs and finds the HSLKXTRA.FIL list
  187.         and copies them to the log and exits, then Opus finds these files
  188.         in the LOG file and Asks for descriptions.
  189.  
  190. [Opus:]
  191.  
  192.   Describe FILE2.ARJ : ______________________________________________
  193.   Describe FILE2.ARJ : ______________________________________________
  194.  
  195.  
  196.  Transfer Successful....... Etc..Etc..
  197.  
  198.  
  199.  
  200.                        -Opus Hslink Interface 2.0-                   [10]
  201.  
  202. Credits and Revisions:
  203. ----------------------
  204.  Opus   is a Copyright (C)1986-1992 of Wynn Wagner III.
  205. Hs/Link is a Copyright (C)1991-1992 of Samuel H. Smith (Tool Shop BBS).
  206. Bimodem is a Copyright (C)1990-1992 of Erik Labs.
  207.  
  208.  [Rev .5] 01/3/92  Wrote and Tested O-HSLINK
  209.  [Rev .6] 01/5/92  Fixed Upload Description Problem
  210.  [Rv 1.0] 1/12/92  More code, alternate program added;First General Release
  211.  [Rv 1.1] 1/23/92  Wide-Beta Test...Changed minor coding/paths corrected
  212.  [Rv 1.2] 2/26/92  Hslink 1.01 Con/Aux bugfix in Protocol <Not Released>
  213.  [Rv 1.3] 3/03/92  Changed Upload instructions. Made Sendlist and Extrafile
  214.                    listings TASK-Specific for better tweaking abilities to
  215.                    those brave souls running multi-line Opus's.
  216.  [Rv 2.0] 7/14/92  Added environment variable..added 8088 instruction mix
  217.                    (should work on XT's now!) changed several bugs in path
  218.  [Rv 2.0a]7/15/92  Fixed Documentation...Env Var is 'OPUSINT' NOT 'OpusLink'
  219.  [Rv 2.0b]7/19/92  Files > 1Megs should process without error now.
  220.  
  221.  
  222.  
  223.                        -Opus Hslink Interface 2.0-                   [11]
  224.  
  225.  
  226.  
  227.        If you are using Opus-Hslink, please consider sending a small
  228.        donation of $5 to keep the upgrades coming. If you have any
  229.        extra floppies that would be fine too <Grin>.
  230.  
  231.                               Dom Montalto
  232.                            1617 Huckins Road
  233.                          Cheshire, Ct USA 06410
  234.  
  235.        Opus-link has been tested with Opus versions 1.70, 1.72, 1.73
  236.        and Opus 1.99, however there is no guarantee that it will work
  237.        on Opus 2.0 when it is released as that version is still in
  238.        Gamma stage as of this writing.  If you have problems, questions
  239.        or suggestions for future versions of O-Hslink, send Netmail to
  240.        Cygnus X-I (1:141/885, 8:909/10, 23:703/8, 65:150/885) or address
  241.        question to Al Filandro in the Opus-Sysops MEADOW conference.
  242.  
  243.  
  244.                        Thank you for your support!
  245.  
  246.